home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIDirectoryEnumerator.idl < prev    next >
Encoding:
Text File  |  2006-05-08  |  2.7 KB  |  69 lines
  1. /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ 
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is the Directory Enumerator Interface.
  16.  *
  17.  * The Initial Developer of the Original Code is Google Inc.
  18.  * Portions created by the Initial Developer are Copyright (C) 2005
  19.  * the Initial Developer. All Rights Reserved.
  20.  *
  21.  * Contributor(s):
  22.  *   Ben Goodger <ben@mozilla.org>
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37.  
  38. #include "nsISupports.idl"
  39.  
  40. interface nsIFile;
  41.  
  42. /**
  43.  * This interface provides a means for enumerating the contents of a directory.
  44.  * It is similar to nsISimpleEnumerator except the retrieved entries are QI'ed 
  45.  * to nsIFile, and there is a mechanism for closing the directory when the 
  46.  * enumeration is complete.
  47.  * 
  48.  * @status UNDER_REVIEW
  49.  */
  50. [scriptable, uuid(31f7f4ae-6916-4f2d-a81e-926a4e3022ee)]
  51. interface nsIDirectoryEnumerator : nsISupports
  52. {
  53.   /**
  54.    * Retrieves the next file in the sequence. The "nextFile" element is the 
  55.    * first element upon the first call. This attribute is null if there is no 
  56.    * next element.
  57.    */
  58.   readonly attribute nsIFile nextFile;
  59.  
  60.   /**
  61.    * Closes the directory being enumerated, releasing the system resource.
  62.    * @throws NS_OK if the call succeeded and the directory was closed.
  63.    *         NS_ERROR_FAILURE if the directory close failed. 
  64.    *         It is safe to call this function many times. 
  65.    */
  66.   void close();
  67. };
  68.  
  69.